<HTML><HEAD><TITLE>module_result(+OptionList)</TITLE>
</HEAD><BODY>[ <A HREF="index.html">library(instrument)</A> | <A HREF="../../index.html">Reference Manual</A> | <A HREF="../../fullindex.html">Alphabetic Index</A> ]
<H1>module_result(+OptionList)</H1>
Pretty-print all files in a module, including any 
   instrumentation results
<DL>
<DT><EM>OptionList</EM></DT>
<DD>List of options
</DD>
</DL>
<H2>Description</H2>
<P>
   This will pretty-print all source files in the calling
   module context, annotated with the result of instrumentation. 
   The resulting .html files are placed in a sub-directory called 
   instrument', relative to the files that were compiled into the file.
   </P><P>
   OptionList is a list of options identical to the one accepted by 
   <TT>pretty_print/2</TT> in the library(pretty_printer), and can be 
   used to modify the output style and the location of the output file.
   </P><P>
   Additionally, OptionList may contain the following options:
   <DL><DT>
   <TT>ignore_module_templates</TT> (default:<TT>off</TT>)
   <DD>
   Specifying this option as <TT>on</TT> results in the 
   use of file local templates only during instrumentation. 
   Templates are not sought from the global store.
   <P>
   This option should only be specified if it was also specified 
   during instrumentation (i.e. when using 
   <TT>instrument:instrument/3</TT>).
   <DT>
   <TT>macro_expansion</TT> (default:<TT>off</TT>)
   <DD>
   This option affects only the printing of the result (html) file. 
   By default, read-macros are not expanded in this output. 
   In rare cases, where macro expansion would affect the placement of 
   instrumentation positions, it may be necessary to set 
   this option to <TT>on</TT> in order to display the instrumentation 
   at the correct positions in the code.
   <P>
   <DT>
   <TT>verbose</TT> (default:<TT>off</TT>)
   <DD>
   If set to <TT>on</TT>, the instrument preprocessor 
   will print predicate names as they are processed (to 
   log_output). 
   If set to <TT>debug</TT>, the instrument preprocessor 
   prints each instrumented and/or woven predicate definition (to 
   log_output).
   </DL>
   </P><P>
   The use of this predicate is only meaningful if the module has 
   previously been instrumented and compiled 
   using <TT>instrument:instrument/1,2</TT>, and the code has been 
   run in order to obtain instrumentation results.
   </P><P>
   See <TT>struct(itemplate)</TT> for documentation of how the 
   result instrumentation is used in the annotation and pretty-printing 
   of the code.
   </P><P>
   The predicate is a tool and the instrumentation results of a 
   module other than the current calling module context can be obtained 
   by invoking <TT>module_result(OptionList)@Module</TT>.
   <P>
<H3>Modules</H3>
This predicate is sensitive to its module context (tool predicate, see @/2).
<H2>See Also</H2>
<A HREF="../../lib/instrument/instrument-2.html">instrument / 2</A>, <A HREF="../../lib/instrument/instrument-3.html">instrument / 3</A>, <A HREF="../../lib/instrument/file_result-1.html">file_result / 1</A>, <A HREF="../../lib/instrument/file_result-2.html">file_result / 2</A>, <A HREF="../../lib/instrument/index.html">library(instrument)</A>, <A HREF="../../lib/pretty_printer/index.html">library(pretty_printer)</A>, <A HREF="../../lib/instrument/module_result-0.html">module_result / 0</A>, <A HREF="../../lib/instrument/itemplate-s.html">struct(itemplate)</A>, <A HREF="../../lib/instrument/defined_modules-2.html">defined_modules / 2</A>
</BODY></HTML>
